﻿/*
 * Copyright 2012 The Netty Project
 *
 * The Netty Project licenses this file to you under the Apache License,
 * version 2.0 (the "License"); you may not use this file except in compliance
 * with the License. You may obtain a copy of the License at:
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations
 * under the License.
 *
 * Copyright (c) 2020 The Dotnetty-Span-Fork Project (cuteant@outlook.com) All rights reserved.
 *
 *   https://github.com/cuteant/dotnetty-span-fork
 *
 * Licensed under the MIT license. See LICENSE file in the project root for full license information.
 */

namespace DotNetty.Handlers.IPFilter
{
    using System.Net;

    /// <summary>
    /// Implement this interface to create new rules.
    /// </summary>
    public interface IIPFilterRule
    {
        /// <summary>
        ///  This method should return true if remoteAddress is valid according to your criteria. False otherwise.
        /// </summary>
        bool Matches(IPEndPoint remoteAddress);
        
        /// <summary>
        /// This method should return <see cref="IPFilterRuleType.Accept"/> if all
        /// <see cref="Matches"/> for which <see cref="Matches"/>
        /// returns true should the accepted. If you want to exclude all of those IP addresses then
        /// <see cref="IPFilterRuleType.Reject"/> should be returned.
        /// </summary>
        IPFilterRuleType RuleType { get; }
    }
}